Skip to content

Conversation

@ntoll
Copy link
Member

@ntoll ntoll commented Jan 8, 2026

SOME OF THE EXAMPLES WON'T WORK because they target 2026.1.1 (which is yet to be released).

This PR is stacked on the work done to automatically generate API docs from our source code. It must only be merged after the next release of PyScript, since it documents and makes use of some of the breaking (pyscript.web related) changes.

This PR involves:

  • Restructuring the documentation into more logical sections.
  • Simplifying the structure so duplications and complex cross-references are (to the best of our ability) removed.
  • Checking the content for accuracy.
  • Updating the language to make it simpler, better organised and easier to understand.
  • Adding example apps based on specific PyScript features.
  • Removal of the old PSDC based example apps.
  • In the user guide, always having a "what's next" section at the end of a page so folks have somewhere to go.
  • In the user guide, embedding the example apps in appropriate places.

TODO:

  • Check again the example apps.
  • Ensure example app information is coherent.
  • Check FAQ.

FEEDBACK WELCOME

@ntoll ntoll force-pushed the user-guide-updates branch from 2bc3162 to d6bf860 Compare January 8, 2026 15:51
@ntoll
Copy link
Member Author

ntoll commented Jan 15, 2026

OK. I've done the final corrections and checks. Ready for review.

NOTE The examples do not work as is because version 2026.1.1 has not (yet) been released. When this happens, it'll all work. 👍

@ntoll ntoll marked this pull request as ready for review January 15, 2026 18:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants